1. Overview

This Read Me file contains last-minute product information for the USBMobileHS™ software for Microsoft Windows. For full instructions on using the USBMobileHS™ please see the User's Manual and other documents provided with this product.

2. System Requirements

The following is a list of recommendations for the configuration of the host machine that runs the USBMobileHS™ application and that is connected to the USBMobileHS™ system. Please note that the application would operate on systems with less memory and slower CPU rate than the recommended; however, for best results it is recommended that the host machine meets or exceeds the suggested configuration.

2.1. Software

Operating System:

Microsoft Windows Windows 2000 or Windows XP.

Required setup:

Microsoft Internet Explorer, version 5 or newer.

2.2. Hardware

Processor:

For optimum performance, use processors of Intel's PentiumIII/Pentium4 family, AMD’s Athlon/Duron family, or other compatible processors with clock speed of 500mHz or higher (Processors of Intel’s Pentium II/Celeron family or AMD’s K6 family with clock speed of 300mHz is a minimum).

Memory:

For the best performance, it is recommended to have at least 128MB of physical RAM.

Hard Disk:

At least 20MB of free hard disk space is required for the installation. Additional disk space is needed for the operation of the applications and for storing the recorded data in files during the recordings process (can be as much as 150MB when recording a full buffer size).

Display:

Resolution of at least 1024 x 768 with at least 16-bit color depth is recommended (resolution of 800 × 600 with 16-bit color is a minimum).

Connectivity:

A PCMCIA slot is required to connect to the USBMobileHS™ analyzer card. This is not a requirement if the application is going to be used only as a viewer

3. Release Notes

3.1. What’s New

1. This is version 2.15 of the USBMobileHS ™ protocol analyzer.

2. This release contains the following components, which are necessary for the operation of the product:

o USB MobileHS™ Application Version 2.15.

o USB MobileHS™ Bus Engine Version 1.03.

1. This release includes the following updates and fixes:

The Navigator functionality was enhanced.

High Level Decoding Mapping User Interface Enhancements:

§ Access Decoding Dialog via "Decode" Button in Toolbar (Always available)

§ Access Decoding Dialog from ANY packet, transaction, or transfer (You previously had to look for an appropriate entry!)

§ Single click selection of decoders (was select then apply)

§ Selection choices now direction-aware (only applicable ones added to selection list)

CCID Messages for Bulk Endpoint decoding were added

Fixed ACK direction field after tokens in splits. (C0005278)
Fixed false incomplete for split IN transactions. (C0005322)
Fixed issue with Standard Requests not being decoded when in Video Decode Script Decoding mode. (C0005399)
Fixed issue with Data toggle and display errors when Control Endpoint is not endpoint 0. (C0006322)
When converting from Interrupt Transfer to Bulk Transfer, data payload loses one byte of data. This was fixed in this release. (C0006508)
Fixed issue with Mass Storage decoding (Incorrect data size when CSW is at end of transfer). Fixed issue with PTP decoding (Incorrect container length displayed). (C0006853)
Now, 16 view flags are allowed compared to previously only 5 flags. (C0006855)
Improved the Hub Class Decoding. (C0006801)

Toggle Analysis improvements. (C0005148)
Fixed bandwidth calculation to include NYET'ed traffic. (C0006044)
Fixed issue of not marking incorrect packet length if data length is larger than speed and transfer type allows. (C0006343)

3.2. Known Issues

· Errors may appear in the last couple of packets of a recording, which are not real errors. They are a side effect of the recording terminated during the middle of a packet. Also, the first packet in a trace may be a partial one.

· Installation requires the existence of command.com file, which is not present on a fresh install of Windows 2000.

· Upon plug-in or unplug, it is possible to see K and J signals that may not reflect the real bus conditions, but are a side-effect of the circuitry of the analyzer probe. These should be ignored.

· In order to use Automation, you must first launch UsbMobileHS.exe on the server, then connect from the client.

3.3. API

Automation:

· Sample files Installation: To install the sample files, please select the ‘Custom’ installation option and select the ‘Automation’ group. The samples are suitable for the USB MobileHS™ analyzer. Please refer to the Automation manual for additional information.

· To run the sample files, you should make sure that the USB MobileHS™ software is already installed.

· The library file name to be used is: USBAutomation.tlb for the USB MobileHS™ analyzer.

· HTML Sample:

· For editing the HTML sample code you can use a text editor or other HTML-editing tools.

· CPP sample:

1. To compile the Visual C++ sample project you first need to install the Microsoft Visual Studio.

2. You can select to install the USB MobileHS™ software in a directory different than the default one. If you choose to do so, make sure you add a path to the installation directory in your project’s paths list. You can find the USBAutomation.tlb file in the installation directory. When using Microsoft Visual Studio, the path to the installation directory should be added to the following places in the ‘Project Settings’ property sheet:

(1) Under ‘C/C++’ tab, ‘Preprocessor’ category in the ‘Additional include directories’.

(2) Under ‘Resources’ tab, in the ‘Additional resource include directories’.

· When a remote server is disconnected abruptly while a client application is still connected, the client application might hang up for several minutes. At the end of this timeout, the client would be released with a “The RPC server unavailable” notification. This is due to Windows conduct. [C0004997]

3.3.1. CATCAnalyzerAdapter - Establishing remote connection from script client:

This automation server allows to launch and access CATC analyzer automation servers dynamically at run-time and remotely ( as long as all necessary DCOM settings and permissions are set on the remote server ) and successfully handle automation events from them in situations where otherwise it is difficult or impossible. The examples below will show how limitations imposed by script engines used in HTML browsers and Windows Script Host could be overridden using this adapter server.

Classid : A0CB5386-38BA-4970-8782-3D1B707C3E5F

ProgID : CATC.AnalyzerAdapter

COM server : CATCAnalyzerAdapter.exe

Primary default interface : IAnalazerAdapter

3.3.1.1. IAnalyzerAdapter::CreateObject

HRESULT CreateObject ([in] BSTR class_id,

[in,optional] BSTR host_name,

out, retval] IDispatch** ppNewObj );

This method instantiates CATC analyzer object on local or remote machine and attaches it to the adapter

Parameters

class_id - string representation of classid, or ProgId ( "clsid: 0B179BB3-DC61-11d4-9B71-000102566088" or "CATC.USBTracer" for CATC USB analyzer )

host_name - the name of the remote server where the analyzer object should be instantiated. Empty value means localhost.

ppNewObj - pointer to the created remote object, NULL if the object has not been instantiated or accessed

Return values

Remarks

Only CATC analyzer COM servers can be instantiated through this method. The method Detach ( see below ) should be called when the work with the remote object is completed( NOTE: The pointer returned in ppNewObj should be released separately ).

Example

VBScript:

</HEAD>

<OBJECT id=AnalyzerAdapter

classid=clsid:A0CB5386-38BA-4970-8782-3D1B707C3E5F>

</OBJECT>

...

<!--

Sub BtnConnect_onclick

On Error Resume Next

Set Analyzer = AnalyzerAdapter.CreateObject("CATC.USBTracer", RemoteServer.value )

if Not Analyzer Is Nothing Then

window.status = "USBTracer connected"

else

msg = "Unable to connect to USBTracer"

MsgBox msg, vbCritical

window.status = msg

End If

End Sub

-->

</SCRIPT>

WSH:

' Create CATC analyzer adapter first..

Set AnalyzerAdapter = WScript.CreateObject("CATC.AnalyzerAdapter", "Analyzer_")

RemoteServer = "EVEREST"

Set Analyzer = AnalyzerAdapter.CreateObject("CATC.USBTracer", RemoteServer)

Analyzer.StartRecording ( Analyzer.ApplicationFolder & "my.rec" )

...

3.3.1.2. IAnalyzerAdapter:: Attach

HRESULT Attach([in] IDispatch* pObj);

This method attaches CATC analyzer object to the adapter.

Parameters

pObj - pointer to the CATC analyzer object to be attached.

Return values

Remarks

Only CATC analyzer COM servers can be attached to the adapter. If some other analyzer object was previously attached to the adapter it will be detached by this call. When the analyzer object gets attached to the adapter a client application using the adapter becomes able to handle automation events fired by the remote analyzer object through adapter.

Example

VBScript:

</HEAD>

<OBJECT id=AnalyzerAdapter

classid=clsid:A0CB5386-38BA-4970-8782-3D1B707C3E5F>

</OBJECT>

...

<!--

Sub BtnConnect_onclick

On Error Resume Next

Set Analyzer = CreateObject("CATC.USBTracer" ) 'VBScript function creates object locally

if Not Analyzer Is Nothing Then

AnalyzerAdapter.Attach Analyzer ' attach analyzer to the adapter

window.status = "USBTracer connected"

else

msg = "Unable to connect to USBTracer"

MsgBox msg, vbCritical

window.status = msg

End If

End Sub

-->

</SCRIPT>

WSH:

' Create CATC analyzer adapter first..

Set AnalyzerAdapter = WScript.CreateObject("CATC.AnalyzerAdapter", "Analyzer_")

'VBScript functioncreates object locally

Set Adapter = WScript.CreateObject("CATC.AnalyzerAdapter")

AnalyzerAdapter.Attach Analyzer ' Attach analyzer object to the adapter

Analyzer.StartRecording ( Analyzer.ApplicationFolder & "my.rec" )

...

3.3.1.3. IAnalyzerAdapter:: Detach

HRESULT Detach();

This method detaches the CATC analyzer object from the adapter.

Parameters

Return values

Remarks

This method detaches an analyzer object from the adapter. This method doesn't guarantee that all resources associated with the detached object will be freed. All existing pointers to that object should be released to destroy the remote object.

Example

VBScript:

</HEAD>

<OBJECT id=AnalyzerAdapter

classid=clsid:A0CB5386-38BA-4970-8782-3D1B707C3E5F>

</OBJECT>

...

<!--

Sub BtnConnect_onclick

On Error Resume Next

Set Analyzer = AnalyzerAdapter.CreateObject("CATC.USBTracer", RemoteServer.value )

if Not Analyzer Is Nothing Then

window.status = "USBTracer connected"

else

msg = "Unable to connect to USBTracer"

MsgBox msg, vbCritical

window.status = msg

End If

End Sub

Sub BtnDisconnect_OnClick

AnalyzerAdapter.Detach ' Detach the analyzer object from adapter

Set Analyzer = Nothing ' Release the pointer to the analyzer returned by CreateOject()

window.status = "USBTracer disconnected"

End Sub

-->

</SCRIPT>

WSH:

' Create CATC analyzer adapter first..

Set AnalyzerAdapter = WScript.CreateObject("CATC.AnalyzerAdapter", "Analyzer_")

RemoteServer = "EVEREST"

Set Analyzer = AnalyzerAdapter.CreateObject("CATC.USBTracer", RemoteServer)

Analyzer.StartRecording ( Analyzer.ApplicationFolder & "my.rec" )

...

AnalyzerAdapter.Detach ' - Disconnect the remote analyzer from the adapter

Set Analyzer = Nothing ' - Release the analyzer ...

'Release the adapter ...

Set AnalyzerAdapter = Nothing

3.3.1.4. IAnalyzerAdapter:: IsValidObject

HRESULT IsValidObject([in] IDispatch *pObj,

[out,retval] VARIANT_BOOL* pVal );

This method helps to determine whether some automation object can be attached to the adapter.

pObj – pointer to the object validated

pVal – pointer to the varable receiving result. TRUE if the validated object can be attached FALSE otherwise.

Parameters

Return values

Remarks

Only CATC analyzer COM servers can be attached to the adapter.

Example

VBScript:

</HEAD>

<OBJECT id=AnalyzerAdapter

classid=clsid:A0CB5386-38BA-4970-8782-3D1B707C3E5F>

</OBJECT>

...

<!--

Sub BtnConnect_onclick

'Launch MS Excel instead of USBTracer!!!

Set Analyzer = CreateObject("Excel.Application")

Analyzer.Visible = True

If Not AnalyzerAdapter.IsValidObject( Analyzer ) Then

MsgBox "The object cannot be attached", vbCritical

Set Analyzer = Nothing

Exit Sub

End If

End Sub

-->

</SCRIPT>

4. Previous Releases

4.1. Version 2.12, Build 237

New Features:

· Video Class decoding of Descriptors, Requests, and data headers

· Supports Transaction level decoding for Isoch Video Data Headers

· Add shortcuts for Hiding SOF, NAK, Chirp

· Add shortcuts for Display and Recording Options and Generate start/stop

· Add menu selection to load the most recently assigned decoding mapping to a trace file, saving time from having to map each endpoint explicitly

· Endpoint Data Compare feature allows user to select 2 endpoints in a trace and verify that the data in one direction matches the data echoed back.

· Selection of an endpoint for Search, Hide, etc. now includes the direction, so (for example) Endpoint 3 OUT and Endpoint 3 IN are treated separately

· Separate USBTracer API library from Advisor API library so they can be used by themselves

· File Open dialogs now include BOTH .usb and .utg files

Bug Fixes:

· PTP/Still Image decoding bug fixes

· Add "Complete No" field to show transactions which are not completed, as is done in USB Chief

· Remove extraneous data that was occuring during Export Data feature.

· Fix Timing Calculator time base default behavior

· Allow decoding of captures which have truncated data, as best as we can.

· Fix erroneous Toggle Violation Error that occured after a SET_INTERFACE command

· Fix Bandwidth calculation error when small number of packets being measured

· Fix minor PTP and OTG Decoding errors

· Fix truncated export of Transactions to .CSV files

4.2. Version 2.03, Build 286

New Features:

· Picture Transfer Protocol /Still Image Class Decoding

· Trigger Timestamp added to File Information

Bug Fixes:

· Fix turnaround violation trigger when it is the last packet before reset

· Fix Mass Storage Decoding bug that prevented complete decoding in cases where Writes were started very quickly after the previous one completed.

· Add more tolerance for SE1 conditions

· Filter SE0 conditions better (Don’t report them if marginal)

4.3. Version 2.02, Build 257

Bug Fixes:

· Add EOP Error Trigger back.

· Clean up Chirp and Full Speed J & K Bus Condition Recording

· Fix search for data pattern in Transfer bug

· Fix BNC output trigger problems.

· Add more tolerance for SE1 conditions

· Filter SE0 conditions better (Don’t report them if marginal)

4.4. Version 2.01, Build 254

This is the first Release of USBMobileHS™.

The USBMobileHS application is based on the USB Advisor and USBTracer applications. For a comprehensive list of updates and modifications to those software packages that that led to this initial USBMobileHS™ release, you are welcome to download them from the LeCroy web site (www.lecroy.com).

5. Support

Online Download

Please periodically check LeCroy Protocol Solutions Group’s web site for software updates and other support related to this product. Software updates are available to those users with current Maintenance Agreements.

Online Support

Web: http://www.lecroy.com/

E-Mail: mailto:support@catc.com

Phone Support

Voice: +1 800 909 2282 (USA/Canada)

+1 408 727 6600 (worldwide)

Fax: +1 408 727 6622 (worldwide)

Sales Information

E-Mail: mailto:contact.corp@lecroy.com

LeCroy, LeCroy Protocol Solutions Group, USBMobile™, USBMobileHS™, USB Advisor™, USB Chief™, USBTracer™ and USBTrainer™ are trademarks of LeCroy Corporation.

Microsoft Windows is a registered trademark of Microsoft Inc.

Pentium is a trademark of Intel Corporation.

Athlon and Duron are trademarks of Advanced Micro Devices, Inc.

Acrobat, Acrobat Reader and the Acrobat logo are trademarks of Adobe Systems Incorporated.

LeCroy reserves the right to revise these specifications without notice or penalty.

Table of Contents

2.1. Software

2.2. Hardware

3.3. API

3.3.1. CATCAnalyzerAdapter - Establishing remote connection from script client:

4. Previous Releases

4.1. Version 2.12, Build 237

4.2. Version 2.03, Build 286

4.3. Version 2.02, Build 257

4.4. Version 2.01, Build 254

Online Support

Phone Support

Sales Information